Maintaines a list of LSAEMailItemS
- Version:
-
1.2.4, 23.NOV.2000
<BR>
- History:
| 23.NOV.2000 | RGR | bug in Get EMailDefaultS
|
| 27.JUL.2000 | RGR | property DefaultEmail changed
|
| 08.JUN.2000 | RGR | delete method changed
|
Public Property Get DefaultEMail AsString
Returns the formatted attribute of the default LSAEMailItem
of the named list.
- History:
| 27.JUL.2000 | RGR | if list is empty an empty string is returned
|
Public Property Get EMailList AsVariant
Returns an array of serial data strings. Each entry corresponds to a
email address in the NamedList and can be used to explode the list.
Public Property Get EMailKeyS AsVariant
Returns an array of string with the keys
of the email addresses maintained in the list
Public Property Get EMailAddresseS AsVariant
Returns an array of string filled with the
the formatted attribute of the LSAEMailtems
maintained by the list
Public Property Get EMailDefaultS AsVariant
Returns an array of strings. On the position of the DefaultItem of
the list the value is "x"
- History:
| 23.NOV.2000 | RGR | CurrentItemKey Point not moved correctly
|
Public Property Get Count AsInteger
Returns the number of elements in the email list
Public Property Set ListDelimiter AsString
When the object is imploded to a serial data string this character will be used as seperator.
If the programmer doesn't set a delimiter a default value will be delivered by the class.
Public Property Get ListDelimiter AsString
Public Property Set ItemDelimiter AsString
When the an item is imploded to a serial data string this character will be used as seperator.
If the programmer doesn't set a delimiter a default value will be delivered by the class.
Public Property Get ItemDelimiter AsString
Public Property Set NotAllowedChars AsVariant
These characters are not allowed to be use in the items
Public Property Get NotAllowedChars AsVariant
New
Public Sub New
Initialzes the internal NamedLists.
Delete
Public Sub Delete
Default destructor of the class. Deletes all child objects
- History:
| 08.JUN.2000 | RGR | Delete the children
|
AddItem
Public Sub AddItem(NewItem As LSAEMailItem)
Adds a new LSAEMailItem to the list
- Parameters:
| newItem | LSAEMailItem | the item which is inserted in the list
|
ClearCurrentItem
Public Sub ClearCurrentItem
Deletes the current item from the list
ClearAllItems
Public Sub ClearAllItems
Reinitializes the email list
UpdateCurrentItem
Public Sub UpdateCurrentItem(UpdateItem As LSAEMailItem)
Updates the current item with the data from the UpdateItem
- Parameters:
| updateItem | LSAEMailItem | item storing the update information
|
IsDefault
Public Function IsDefault(CompareItem As LSAEMailItem) As Integer
Checks if the parameter item is the default item of the list.
- Returns:
| Boolean | true, if the item is the default item
|
SetCurrentItem
Public Sub SetCurrentItem(NewCurrentItem As LSAEMailItem)
Set the current item to the parameter item
SetDefaultItem
Public Sub SetDefaultItem(NewDefaultItem As LSAEMailItem)
Set the default item to the parameter item
GetItemByKey
Public Function GetItemByKey(ItemKey As String,MoveCurrentItem As Integer) As LSAEMailItem
GetDefaultItem
Public Function GetDefaultItem As LSAEMailItem
Returns the default item of the list or nothing.
- Returns:
| LSAEMailItem | the default item
|
GetCurrentItem
Public Function GetCurrentItem As LSAEMailItem
Returns the current item of the list
- Returns:
| LSAEMailItem | item which the current pointer is pointing at
|
GetFirstItem
Public Function GetFirstItem As LSAEMailItem
Returns the first item of the list
- Returns:
| LSAEMailItem | the first item in the list
|
GetNextItem
Public Function GetNextItem As LSAEMailItem
Returns the item next to the current item of the list.
- Returns:
| LSAEMailItem | next item to the current item
|
GetPreviousItem
Public Function GetPreviousItem As LSAEMailItem
saveToPredefinedFields
Public Function saveToPredefinedFields(doc As NotesDocument) As Integer
Stores attribute values for the convinience of the programmer. The
fields of documents relate to the subform LSASubEMail from LSL-Address
The attribute are only stored if they differ from the values on disk.
- Parameters:
| doc | NotesDocument | the document in which the attributes are stored
|
- Returns:
| Boolean | true, if one item of the document has been changed
|
Explode
Public Sub Explode(SerialDataArr As Variant)
Fills the list with the serialized object provided by the parameter array
The array should be of th form
[~x~~Notes~John Doe/ACME~John Doe/ACME,
' ~~~Internet~John Doe@Acme.com~John Doe@ACME.COM]
The list also reinitialized this means hasChanged delivers false.
- Parameters:
| SerialdataArr | Variant | array of serial data strings each entry representing an item
|
hasChanged
Public Function hasChanged As Integer
Checks if the list has been modified since creation or the last call of the explode
method.
getEMailData
Public Function getEMailData As String
Interface for the class LSAAddressData. Calculates a string of the
type ##LotusE# as used in the default data string
of an unit
| Top | LotusScript Doc |
| © Lotus Professional Services |
| generated on : 05-Apr-01 8:40:00 AM |